Namespaces
namespace	utility

Functions
SonyOzResult	LinkXrLibrary (SonyOzPlatformId platform_id)
	Link the library and make the API available.

void	UnlinkXrLibrary ()
	Terminate use of XR API and unlink the library.

SonyOzResult	GetDeviceNum (SonyOzPlatformId platform_id, uint64_t *num)
	Get the number of available devices.

SonyOzResult	EnumerateDevices (SonyOzPlatformId platform_id, uint64_t size, SonyOzDeviceInfo *device_list)
	Obtain information on available devices.

SonyOzResult	SetDebugLogCallback (SonyOzPlatformId platform_id, SonyOzLogSettings_LogCallback callback)
	Change the log output destination to the specified function.

SonyOzResult	CreateSession (SonyOzPlatformId platform_id, const SonyOzDeviceInfo device, RUNTIME_OPTION_BIT_FLAG runtime_option_bit_flag, PLATFORM_OPTION_BIT_FLAG platform_option_bit_flag, SonyOzSessionHandle session)
	Create session with XR Platform.

SonyOzResult	DestroySession (SonyOzSessionHandle *session)
	Destroy session with XR Platform.

SonyOzResult	BeginSession (SonyOzSessionHandle session)
	Start a session with the XR Platform.

SonyOzResult	EndSession (SonyOzSessionHandle session)
	Terminate the session with XR Platform.

SonyOzResult	GetSessionState (SonyOzSessionHandle session, SonyOzSessionState *session_state)
	Obtain session status.

SonyOzResult	UpdateTrackingResultCache (SonyOzSessionHandle session)
	Update the cache of tracking data.(for Game Thread)

SonyOzResult	GetCachedPose (SonyOzSessionHandle session, SonyOzPoseId pose_id, SonyOzPosef pose, bool is_valid)
	Obtain information about the camera.

SonyOzResult	GetProjection (SonyOzSessionHandle session, SonyOzPoseId pose_id, SonyOzProjection *projection)
	Obtain Projection.

SonyOzResult	SubmitD3d11 (SonyOzSessionHandle session, ID3D11Device device, ID3D11Texture2D side_by_side, bool flip_y_position, ID3D11Texture2D *target)
	Generate render textures and shaders for D3D11. (single pass)

SonyOzResult	SubmitD3d12 (SonyOzSessionHandle session, ID3D12CommandQueue command_queue, uint32_t node_mask, ID3D12Resource side_by_side, bool flip_y_position, DXGI_FORMAT format, ID3D12Resource *target)
	Generate render textures and shaders for D3D11. (single pass)

SonyOzResult	SubmitOpengl (SonyOzSessionHandle session, unsigned int side_by_side, bool flip_y_position, unsigned int target)
	Generate render textures and shaders for D3D11. (single pass)

SonyOzResult	SubmitMultiPassD3d11 (SonyOzSessionHandle session, ID3D11Device device, ID3D11Texture2D left, ID3D11Texture2D right, bool flip_y_position, ID3D11Texture2D target)
	Generate D3D11 render textures and shaders for off-screen rendering and shaders. (multi-pass)

SonyOzResult	SubmitMultiPassD3d12 (SonyOzSessionHandle session, ID3D12CommandQueue command_queue, uint32_t node_mask, ID3D12Resource left, ID3D12Resource right, bool flip_y_position, DXGI_FORMAT format, ID3D12Resource target)
	Generate D3D12 render textures and shaders for off-screen rendering and shaders. (multi-pass)

SonyOzResult	SubmitMultiPassOpengl (SonyOzSessionHandle session, unsigned int left, unsigned int right, bool flip_y_position, unsigned int target)
	Generate render textures and shaders for D3D11. (single pass)

SonyOzResult	EnableStereo (SonyOzSessionHandle session, bool enable)
	Enables/disables stereo rendering.

SonyOzResult	GetTargetMonitorRectangle (SonyOzSessionHandle session, SonyOzRect *rect)
	Obtain information on the target monitor.

SonyOzResult	GetDisplaySpec (SonyOzSessionHandle session, SonyOzDisplaySpec *display_spec)
	Obtain information about the display.

SonyOzResult	GetXrSystemError (SonyOzSessionHandle session, SonyOzXrSystemError *error)
	Obtain an error occurred in XR Runtime.

SonyOzResult	GetXrSystemErrorNum (SonyOzSessionHandle session, uint16_t *num)
	Obtain the number of errors occured in XR Runtime.

SonyOzResult	GetXrSystemErrorList (SonyOzSessionHandle session, uint16_t num, SonyOzXrSystemError *errors)
	Obtain errors occurred in XR Runtime.

SonyOzResult	SetColorSpace (SonyOzSessionHandle session, int input_gamma_count, int output_gamma_count, float gamma)

SonyOzResult	SetCameraWindowEnabled (SonyOzPlatformId platform_id, SonyOzSessionHandle session, const bool enable)
	Show/Hide camera window.

SonyOzResult	GetPauseHeadPose (SonyOzPlatformId platform_id, SonyOzSessionHandle session, bool *enabled)
	Get head pose status.

SonyOzResult	SetPauseHeadPose (SonyOzPlatformId platform_id, SonyOzSessionHandle session, const bool enabled)
	Enable/Disable head pose tracking..

SonyOzResult	GetHighImageQuality (SonyOzPlatformId platform_id, SonyOzSessionHandle session, bool *enabled)
	Get HighImageQuality mode.

SonyOzResult	SetHighImageQuality (SonyOzPlatformId platform_id, SonyOzSessionHandle session, const bool enabled)
	Set HighImageQuality mode.

SonyOzResult	GetCameraImageSize (SonyOzPlatformId platform_id, SonyOzSessionHandle session, int width, int height, int *depth)
	Get Camera Image size.

SonyOzResult	GetCameraImageBuffer (SonyOzPlatformId platform_id, SonyOzSessionHandle session, size_t buffer_size, void buffer)
	Get Camera Image.

SonyOzResult	GetPerformancePriority (SonyOzPlatformId platform_id, SonyOzSessionHandle session, bool *enable)
	Get PerformancePriority mode is enabled or not.

SonyOzResult	GetWallmountMode (SonyOzPlatformId platform_id, SonyOzSessionHandle session, bool *enable)
	Get wallmount mode is enabled or not.

SonyOzResult	SetWallmountMode (SonyOzPlatformId platform_id, SonyOzSessionHandle session, const bool enable)
	Set wallmount mode is enabled or not.

Function Documentation

◆ BeginSession()

SonyOzResult sony::oz::xr_runtime::BeginSession ( SonyOzSessionHandle session )

Start a session with the XR Platform.

Parameters

[in] session Pass session handle.

Returns: SonyOzResult

The session start process is executed when the session state is RUNNING, and the status of the process can be checked with GetSessionState.(When the session state is RUNNING, it can be determined that the session has started.)

Chrome Tracing Profile is output from the time this function is executed.

This function is guaranteed to work even if it is executed multiple times.

Attention: . If this function is executed multiple times, EndSession should be executed that number of times.

◆ CreateSession()

SonyOzResult sony::oz::xr_runtime::CreateSession	(	SonyOzPlatformId	platform_id,
		const SonyOzDeviceInfo *	device,
		RUNTIME_OPTION_BIT_FLAG	runtime_option_bit_flag,
		PLATFORM_OPTION_BIT_FLAG	platform_option_bit_flag,
		SonyOzSessionHandle *	session )

Create session with XR Platform.

Parameters

[in]	platform_id	Specify the ID of the platform to be used.
[in]	device	Pass the information of the device to be used.
[in]	runtime_option_bit_flag	Pass the settings flag of runtime (usually RUNTIME_OPTION_IS_XR_CONTENT is specified).
[in]	platform_option_bit_flag	Pass the settings flag of platform (usually PLATFORM_OPTION_NONE is specified).
[out]	session	A session handle is returned.

Returns: SonyOzResult

Since information on the device to be used is required to create a session, EnumerateDevices (device enumeration library) to obtain device information.

This function is guaranteed to work even if it is executed multiple times.

If the same device information is passed, the same session is obtained; if different device information is passed, a different session is created.

Attention: Multiple sessions to different XR Platforms are not supported. If multiple sessions are executed, DestroySession should be executed for all session handles obtained.

◆ DestroySession()

SonyOzResult sony::oz::xr_runtime::DestroySession ( SonyOzSessionHandle * session )

Destroy session with XR Platform.

Parameters

[in] session Pass session handle.

Returns: SonyOzResult

This function is guaranteed to work even if it is executed multiple times.

Attention: . If multiple session handles are obtained using CreateSession, then execute this function for all acquired session handles.

◆ EnableStereo()

SonyOzResult sony::oz::xr_runtime::EnableStereo	(	SonyOzSessionHandle	session,
		bool	enable )

Enables/disables stereo rendering.

Parameters

[in]	session	Pass the session handle.
[in]	enable	true: enable, false: disable.

Returns: SonyOzResult

Enables/disables stereo rendering.

Attention

◆ EndSession()

SonyOzResult sony::oz::xr_runtime::EndSession ( SonyOzSessionHandle session )

Terminate the session with XR Platform.

Parameters

[in] session Pass session handle.

Returns: SonyOzResult

When the session state is RUNNING, the session termination process is executed, and the status of the process can be checked with GetSessionState (even if the session is not RUNNING, it should be processed). (When the session state is READY, it can be determined that the session has terminated.)

If this function is executed multiple times, EndSession should be executed that number of times.

Attention: To be executed as many times as BeginSession is executed.
If the number of executions of BeginSession is not reached, the session status remains RUNNING.

◆ EnumerateDevices()

SonyOzResult sony::oz::xr_runtime::EnumerateDevices	(	SonyOzPlatformId	platform_id,
		uint64_t	size,
		SonyOzDeviceInfo *	device_list )

Obtain information on available devices.

Parameters

[in]	platform_id	Specify the platform ID to be used.
[in]	size	Specify array size.
[out]	device_list	Device information is set in the array.

Returns: SonyOzResult

Passing the device information to be used from the acquired device list to CreateSession.

Attention: The last element of the array of device information retrieved is the one used internally. The information on connected SRDs ranges from 0 to size-2.

◆ GetCachedPose()

SonyOzResult sony::oz::xr_runtime::GetCachedPose	(	SonyOzSessionHandle	session,
		SonyOzPoseId	pose_id,
		SonyOzPosef *	pose,
		bool *	is_valid )

Obtain information about the camera.

Parameters

[in]	session	Pass the session handle.
[in]	pose_id	Specify the camera to be obtained.
[out]	pose	Camera information is returned.
[out]	is_valid	Camera information is returned.

Returns: SonyOzResult

Information such as the viewpoint posture of the specified camera can be acquired.

Attention: Correct results are returned only when the session state is RUNNING. Otherwise, an error is returned.The pose obtained in case of an error is an undefined value.

◆ GetCameraImageBuffer()

SonyOzResult sony::oz::xr_runtime::GetCameraImageBuffer	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		size_t *	buffer_size,
		void *	buffer )

Get Camera Image.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[in,out]	buffer_size	Size of prepared buffer. If the call succeeds, the actual size copied is returned.
[out]	buffer	Address of the allocated buffer. The memory area must be larger than the size specified by buffer_size.

Returns: SonyOzResult

Get Camera Image. Camera Image is copied to this buffer.

Attention

◆ GetCameraImageSize()

SonyOzResult sony::oz::xr_runtime::GetCameraImageSize	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		int *	width,
		int *	height,
		int *	depth )

Get Camera Image size.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[out]	width	Width of a captured camera image in pixel.
[out]	height	Height of a captured camera image in pxel.
[out]	depth	Bytes per pixel.

Returns: SonyOzResult

Get Camera Image size. Since the size of the camera image is fixed, it is necessary to call only once first to get the size to prepare the buffer.

Attention

◆ GetDeviceNum()

SonyOzResult sony::oz::xr_runtime::GetDeviceNum	(	SonyOzPlatformId	platform_id,
		uint64_t *	num )

Get the number of available devices.

Parameters

[in]	platform_id	Specify the platform ID to be used.
[out]	num	The number of devices is returned.

Returns: SonyOzResult

Attention: The value returned is always the connected devices + 1, since it includes the dummy devices used internally. Therefore, 1 is returned even if none of the devices are connected. To determine if an SRD is connected, it is necessary to determine if the returned value is greater than 1.

◆ GetDisplaySpec()

SonyOzResult sony::oz::xr_runtime::GetDisplaySpec	(	SonyOzSessionHandle	session,
		SonyOzDisplaySpec *	display_spec )

Obtain information about the display.

Parameters

[in]	session	Pass the session handle.
[out]	display_spec	Display information is returned.

Returns: SonyOzResult

Obtain information such as display dimensions, resolution, and tilt.

Attention

◆ GetHighImageQuality()

SonyOzResult sony::oz::xr_runtime::GetHighImageQuality	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		bool *	enabled )

Get HighImageQuality mode.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[in]	enabled	true: HighImageQuality mode is enabled, false: HighImageQuality mode is disabled or not supported.

Returns: SonyOzResult

Get HighImageQuality mode.

Attention

◆ GetPauseHeadPose()

SonyOzResult sony::oz::xr_runtime::GetPauseHeadPose	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		bool *	enabled )

Get head pose status.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
	[in	enabled true: head pose tracking is stopped, false: head pose is tracking.

Returns: SonyOzResult

Get head pose status.

Attention

◆ GetPerformancePriority()

SonyOzResult sony::oz::xr_runtime::GetPerformancePriority	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		bool *	enable )

Get PerformancePriority mode is enabled or not.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[in]	enabled	true: PerformancePriority is enabled, false: PerformancePriority is disabled or not supported.

Returns: SonyOzResult

Get PerformancePriority mode is enabled or not.

Attention

◆ GetProjection()

SonyOzResult sony::oz::xr_runtime::GetProjection	(	SonyOzSessionHandle	session,
		SonyOzPoseId	pose_id,
		SonyOzProjection *	projection )

Obtain Projection.

Parameters

[in]	session	Pass the session handle.
[in]	pose_id	Specify the camera to be obtained.
[out]	projection	Projection is returned.

Returns: SonyOzResult

Obtain the Projection of the left eye, the right eye, and the respective center point.

Attention: Correct information can be obtained only when the session state is RUNNING. Otherwise, an error is returned. In case of an error, the following information is retrieved projection_matrix is undefined.

◆ GetSessionState()

SonyOzResult sony::oz::xr_runtime::GetSessionState	(	SonyOzSessionHandle	session,
		SonyOzSessionState *	session_state )

Obtain session status.

Parameters

[in]	session	Pass the session handle.
[out]	session_state	Session status is returned.

Returns: SonyOzResult

Attention

◆ GetTargetMonitorRectangle()

SonyOzResult sony::oz::xr_runtime::GetTargetMonitorRectangle	(	SonyOzSessionHandle	session,
		SonyOzRect *	rect )

Obtain information on the target monitor.

Parameters

[in]	session	Pass the session handle.
[out]	rect	Window information is returned.

Returns: SonyOzResult

Attention

◆ GetWallmountMode()

SonyOzResult sony::oz::xr_runtime::GetWallmountMode	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		bool *	enable )

Get wallmount mode is enabled or not.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[in]	enabled	true: wallmount is enabled, false: wallmount mode is disabled or not supported.

Returns: SonyOzResult

Get wallmount mode is enabled or not.

Attention

◆ GetXrSystemError()

SonyOzResult sony::oz::xr_runtime::GetXrSystemError	(	SonyOzSessionHandle	session,
		SonyOzXrSystemError *	error )

Obtain an error occurred in XR Runtime.

Parameters

[in]	session	Pass the session handle.
[out]	error	The first error is returned.

Returns: SonyOzResult

Obtain an error occurred in XR Runtime.

Attention

◆ GetXrSystemErrorList()

SonyOzResult sony::oz::xr_runtime::GetXrSystemErrorList	(	SonyOzSessionHandle	session,
		uint16_t	num,
		SonyOzXrSystemError *	errors )

Obtain errors occurred in XR Runtime.

Parameters

[in]	session	Pass the session handle.
[in]	num	Pass the list size.
[out]	errors	The errors are stored in the list.

Returns: SonyOzResult

Obtain errors occurred in XR Runtime.

Attention: num must be less than or equal to the size returned by GetXrSystemErrorNum.

◆ GetXrSystemErrorNum()

SonyOzResult sony::oz::xr_runtime::GetXrSystemErrorNum	(	SonyOzSessionHandle	session,
		uint16_t *	num )

Obtain the number of errors occured in XR Runtime.

Parameters

[in]	session	Pass the session handle.
[out]	num	The number of errors is returned.

Returns: SonyOzResult

Obtain the number of errors occured in XR Runtime.

Attention

◆ LinkXrLibrary()

SonyOzResult sony::oz::xr_runtime::LinkXrLibrary ( SonyOzPlatformId platform_id )

Link the library and make the API available.

Parameters

[in] platform_id Specify the platform ID to be used.

Returns: SonyOzResult

◆ SetCameraWindowEnabled()

SonyOzResult sony::oz::xr_runtime::SetCameraWindowEnabled	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		const bool	enable )

Show/Hide camera window.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[out]	enable	true: show camera window, false: hide camera window.

Returns: SonyOzResult

Show/Hide camera window.

Attention

◆ SetColorSpace()

SonyOzResult sony::oz::xr_runtime::SetColorSpace	(	SonyOzSessionHandle	session,
		int	input_gamma_count,
		int	output_gamma_count,
		float	gamma )

◆ SetDebugLogCallback()

SonyOzResult sony::oz::xr_runtime::SetDebugLogCallback	(	SonyOzPlatformId	platform_id,
		SonyOzLogSettings_LogCallback	callback )

Change the log output destination to the specified function.

Parameters

[in]	platform_id	Specify the platform ID to be used.
[in]	callback	Pass the function to be set as the log output destination.

Returns: SonyOzResult

Registers the log output destination as a callback and outputs the log of this library to an arbitrary location.

Attention

◆ SetHighImageQuality()

SonyOzResult sony::oz::xr_runtime::SetHighImageQuality	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		const bool	enabled )

Set HighImageQuality mode.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[out]	enabled	true: HighImageQuality mode is enabled, false: HighImageQuality mode is disabled or not supported.

Returns: SonyOzResult

Get HighImageQuality mode.

Attention

◆ SetPauseHeadPose()

SonyOzResult sony::oz::xr_runtime::SetPauseHeadPose	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		const bool	enabled )

Enable/Disable head pose tracking..

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[out]	enabled	true: Stop head pose tracking, false: Start head pose tracking.

Returns: SonyOzResult

Enable/Disable head pose tracking.

Attention

◆ SetWallmountMode()

SonyOzResult sony::oz::xr_runtime::SetWallmountMode	(	SonyOzPlatformId	platform_id,
		SonyOzSessionHandle	session,
		const bool	enable )

Set wallmount mode is enabled or not.

Parameters

[out]	platform_id	Indicating XR platform. It will always be "Spatial Reality Display"
[out]	session	Pass the session handle.
[out]	enabled	true: Enable wallmount mode, false: Disable wallmount mode.

Returns: SonyOzResult

Set wallmount mode is enabled or not.

Attention

◆ SubmitD3d11()

SonyOzResult sony::oz::xr_runtime::SubmitD3d11	(	SonyOzSessionHandle	session,
		ID3D11Device *	device,
		ID3D11Texture2D *	side_by_side,
		bool	flip_y_position,
		ID3D11Texture2D *	target )

Generate render textures and shaders for D3D11. (single pass)

Parameters

[in]	session	Pass the session handle.
[in]	device
[in]	side_by_side	Pass a pointer to the SideBySide texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[out]	target	Pass a pointer to the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ SubmitD3d12()

SonyOzResult sony::oz::xr_runtime::SubmitD3d12	(	SonyOzSessionHandle	session,
		ID3D12CommandQueue *	command_queue,
		uint32_t	node_mask,
		ID3D12Resource *	side_by_side,
		bool	flip_y_position,
		DXGI_FORMAT	format,
		ID3D12Resource *	target )

Generate render textures and shaders for D3D11. (single pass)

Parameters

[in]	session	Pass the session handle.
[in]	command_queue
[in]	node_mask
[in]	side_by_side	Pass a pointer to the SideBySide texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[out]	target	Pass a pointer to the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ SubmitMultiPassD3d11()

SonyOzResult sony::oz::xr_runtime::SubmitMultiPassD3d11	(	SonyOzSessionHandle	session,
		ID3D11Device *	device,
		ID3D11Texture2D *	left,
		ID3D11Texture2D *	right,
		bool	flip_y_position,
		ID3D11Texture2D *	target )

Generate D3D11 render textures and shaders for off-screen rendering and shaders. (multi-pass)

Parameters

[in]	session	Pass the session handle.
[in]	device
[in]	left	Pass a pointer to the left eye texture.
[in]	right	Pass a pointer to the right eye texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[out]	target	Pass a pointer to the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ SubmitMultiPassD3d12()

SonyOzResult sony::oz::xr_runtime::SubmitMultiPassD3d12	(	SonyOzSessionHandle	session,
		ID3D12CommandQueue *	command_queue,
		uint32_t	node_mask,
		ID3D12Resource *	left,
		ID3D12Resource *	right,
		bool	flip_y_position,
		DXGI_FORMAT	format,
		ID3D12Resource *	target )

Generate D3D12 render textures and shaders for off-screen rendering and shaders. (multi-pass)

Parameters

[in]	session	Pass the session handle.
[in]	command_queue
[in]	node_mask
[in]	left	Pass a pointer to the left eye texture.
[in]	right	Pass a pointer to the right eye texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[in]	format
[out]	target	Pass a pointer to the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ SubmitMultiPassOpengl()

SonyOzResult sony::oz::xr_runtime::SubmitMultiPassOpengl	(	SonyOzSessionHandle	session,
		unsigned int	left,
		unsigned int	right,
		bool	flip_y_position,
		unsigned int	target )

Generate render textures and shaders for D3D11. (single pass)

Parameters

[in]	session	Pass the session handle.
[in]	left	Pass a pointer to the left eye texture.
[in]	right	Pass a pointer to the right eye texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[out]	target	Pass a texture id of the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ SubmitOpengl()

SonyOzResult sony::oz::xr_runtime::SubmitOpengl	(	SonyOzSessionHandle	session,
		unsigned int	side_by_side,
		bool	flip_y_position,
		unsigned int	target )

Generate render textures and shaders for D3D11. (single pass)

Parameters

[in]	session	Pass the session handle.
[in]	side_by_side	Pass a texture id of the SideBySide texture.
[in]	flip_y_position	Pass whether to invert the Y axis of the VertexShader.
[out]	target	Pass a texture id of the Render Target.

Returns: SonyOzResult

Generate textures for off-screen rendering and shaders.

Attention

◆ UnlinkXrLibrary()

void sony::oz::xr_runtime::UnlinkXrLibrary ( )

Terminate use of XR API and unlink the library.

◆ UpdateTrackingResultCache()

SonyOzResult sony::oz::xr_runtime::UpdateTrackingResultCache ( SonyOzSessionHandle session )

Update the cache of tracking data.(for Game Thread)

Parameters

[in] session Pass the session handle.

Returns: SonyOzResult

Attention: Correct results are returned only when the session state is RUNNING. Otherwise, an error is returned.

Namespaces

Functions

Function Documentation

◆ BeginSession()

◆ CreateSession()

◆ DestroySession()

◆ EnableStereo()

◆ EndSession()

◆ EnumerateDevices()

◆ GetCachedPose()

◆ GetCameraImageBuffer()

◆ GetCameraImageSize()

◆ GetDeviceNum()

◆ GetDisplaySpec()

◆ GetHighImageQuality()

◆ GetPauseHeadPose()

◆ GetPerformancePriority()

◆ GetProjection()

◆ GetSessionState()

◆ GetTargetMonitorRectangle()

◆ GetWallmountMode()

◆ GetXrSystemError()

◆ GetXrSystemErrorList()

◆ GetXrSystemErrorNum()

◆ LinkXrLibrary()

◆ SetCameraWindowEnabled()

◆ SetColorSpace()

◆ SetDebugLogCallback()

◆ SetHighImageQuality()

◆ SetPauseHeadPose()

◆ SetWallmountMode()

◆ SubmitD3d11()

◆ SubmitD3d12()

◆ SubmitMultiPassD3d11()

◆ SubmitMultiPassD3d12()

◆ SubmitMultiPassOpengl()

◆ SubmitOpengl()

◆ UnlinkXrLibrary()

◆ UpdateTrackingResultCache()